Skip to content

add API Extractor coverage for main and core exports - #2157

Open
lukasIO wants to merge 1 commit into
mainfrom
codex/api-extractor-room-smoke
Open

lukasIO wants to merge 1 commit into
mainfrom
codex/api-extractor-room-smoke

Conversation

@lukasIO

@lukasIO lukasIO commented Oct 17, 2026

Copy link
Copy Markdown
Contributor

Summary

  • add committed API Extractor reports for livekit-client and livekit-client/core
  • check both reports in the smoke workflow and provide an update script for intentional API changes
  • exercise Room behavior through the packaged native ESM, UMD, Vite ESM, and webpack CommonJS builds
  • make the connection checker emit valid core declaration types discovered while extracting the core API

Testing

  • full SDK build, worker builds, downlevel declarations, and built-import checks
  • API Extractor checks for the main and core entry points
  • TypeScript and core import/type boundary checks
  • 24 Room-related unit tests
  • 5 Playwright packaged-consumer smoke tests
  • ESLint, Prettier, and Git whitespace checks

Note

API Extractor 7.59.4 currently bundles TypeScript 5.9.3, so it prints an informational warning for this repository's TypeScript 6.0.2 declarations. Both report checks pass.

@changeset-bot

changeset-bot Bot commented Oct 17, 2026 •

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 4868873

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@lukasIO
lukasIO added this pull request to stack #2154 October 17, 2026 10:22
@github-actions

Copy link
Copy Markdown
Contributor

size-limit report 📦

Path Size
dist/livekit-client.esm.mjs 115.84 KB (0%)
dist/livekit-client.umd.js 125.08 KB (0%)
dist/core/core.mjs 78.69 KB (0%)

Base automatically changed from core to main October 19, 2026 09:28
@lukasIO
lukasIO force-pushed the codex/api-extractor-room-smoke branch from 2ca12b8 to 4868873 Compare October 19, 2026 09:28
@lukasIO
lukasIO marked this pull request as ready for review October 19, 2026 09:29
@lukasIO lukasIO changed the title Add API Extractor coverage for main and core exports add API Extractor coverage for main and core exports Oct 19, 2026

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔍 Devin Review: 1 flag

Not posted on this PR by your GitHub settings — view it in Devin Review. (Configure)

Devin Review

@1egoman 1egoman left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code wise, makes sense.

Just generally, I am not super excited about having to deal with api-extractor on this repo (It has been a constant thorn in my side in components-js). Let's discuss in our 1:1, I'd be interested in understanding your motivations here more deeply.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants